/**
 * Twitter_Snowflake
 *
 * SnowFlake 的结构如下(每部分用-分开):
 *      0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000
 *
 * ********************************************************************************************************************
 *
 * 1 位标识，
 *      由于 long 基本类型在 Java 中是带符号的，最高位是符号位，正数是 0，负数是 1，所以 id 一般是正数，最高位是 0
 * 
 * 41 位时间截(毫秒级)，
 *      注意，41 位时间截不是存储当前时间的时间截，而是存储时间截的差值（当前时间截 - 开始时间截) 得到的值，
 *      这里的的开始时间截，一般是我们的 id 生成器开始使用的时间，由我们程序来指定的（如下下面程序 IdWorker 类的 startTime 属性）。
 *      41 位的时间截，可以使用 69 年，年 = (1L << 41) / (1000L * 60 * 60 * 24 * 365) = 69
 * 
 * 10 位的数据机器位，
 *      可以部署在 1024 个节点，包括 5 位 datacenterId 和 5 位 workerId。
 *      即最多 32 个数据中心（地方），每个中心（地方)最多 32 台电脑。即，最多共有 1024 台电脑自己去计算自己的 id
 *      或许我们不一定都需要像这样使用 5 位作为数据中心标识，5 位作为机器标识，可以根据我们业务的需要，灵活分配节点部分。
 *      如：若不需要数据中心，完全可以使用全部 10 位作为机器标识；
 *      若数据中心不多，也可以只使用 3 位作为数据中心，7 位作为机器标识。
 * 
 * 12 位序列，
 *      毫秒内的计数，12 位的计数顺序号支持每个节点每毫秒（同一机器，同一时间截）产生 4096 个 ID 序号加起来刚好 64 位，为一个 Long 型。
 *
 * SnowFlake 的优点是，整体上按照时间自增排序，并且整个分布式系统内不会产生 ID 碰撞(由数据中心 ID 和机器 ID 作区分)，并且效率较高。
 * 经测试，SnowFlake 每秒能够产生 26 万 ID 左右。
 *
 */
public class SnowflakeIdWorker {

    // ==============================Fields===========================================


    /**
     * 数据标识 id 所占的位数
     */
    private static final long dataCenterIdBits = 5L;

    /**
     * 机器 id 所占的位数
     */
    private static final long workerIdBits = 5L;

    /**
     * 序列在 id 中占的位数
     */
    private static final long sequenceBits = 12L;

    /**
     * 开始时间截 (2015-01-01)
     */
    private static final long twepoch = 1489111610226L;


    /**
     * 机器 ID 上限：31 (这个移位算法可以很快的计算出几位二进制数所能表示的最大十进制数)
     */
    // private static final long maxWorkerId = -1L ^ (-1L << workerIdBits); 可简化成如下
    private static final long maxWorkerId = ~(-1L << workerIdBits);


    /**
     * 数据中心 ID 上限：31
     */
    // private static final long maxDataCenterId = -1L ^ (-1L << dataCenterIdBits); 可简化成如下
    private static final long maxDataCenterId = ~(-1L << dataCenterIdBits);

    /**
     * 机器 ID 向左移 12 位
     */
    private static final long workerIdShift = sequenceBits;

    /**
     * 数据标识 id 向左移 17 位(12+5)
     */
    private static final long dataCenterIdShift = sequenceBits + workerIdBits;

    /**
     * 时间截向左移 22 位(5+5+12)
     */
    private static final long timestampLeftShift = sequenceBits + workerIdBits + dataCenterIdBits;

    /**
     * 生成序列的掩码，这里为 4095 (0b111111111111=0xfff=4095)
     */
    // private static final long sequenceMask = -1L ^ (-1L << sequenceBits); 可简化成如下
    private static final long sequenceMask = ~(-1L << sequenceBits);

    /**
     * 工作机器 ID (0~31)
     */
    private long workerId;

    /**
     * 数据中心ID(0~31)
     */
    private long dataCenterId;

    /**
     * 毫秒内序列(0~4095)
     */
    private long sequence = 0L;

    /**
     * 上次生成 ID 的时间截
     */
    private long lastTimestamp = -1L;

    //==============================Constructors=====================================

    public SnowflakeIdWorker() {
        this(0, 0);
    }

    /**
     * 构造函数
     *
     * @param workerId     工作ID (0~31)
     * @param dataCenterId 数据中心ID (0~31)
     */
    public SnowflakeIdWorker(long workerId, long dataCenterId) {
        if (workerId > maxWorkerId || workerId < 0) {
            throw new IllegalArgumentException(String.format("workerId can't be greater than %d or less than 0", maxWorkerId));
        }

        if (dataCenterId > maxDataCenterId || dataCenterId < 0) {
            throw new IllegalArgumentException(String.format("dataCenterId can't be greater than %d or less than 0", maxDataCenterId));
        }

        this.workerId = workerId;
        this.dataCenterId = dataCenterId;
    }

    // ==============================Methods==========================================

    /**
     * 获得下一个ID (该方法是线程安全的)
     *
     * @return SnowflakeId
     */
    public synchronized long nextId() {
        long timestamp = timeGen();

        // 如果当前时间小于上一次 ID 生成的时间戳，说明系统时钟回退过，这个时候应当抛出异常。
        // 出现这种原因是因为系统的时间被回拨，或出现闰秒现象。
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(
                    String.format("Clock moved backwards. Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        // 如果是同一时间生成的，则进行毫秒内序列
        if (lastTimestamp == timestamp) {
            // 相同毫秒内，序列号自增
            sequence = (sequence + 1) & sequenceMask;
            // 毫秒内序列溢出，即，同一毫秒的序列数已经达到最大
            if (sequence == 0) {
                // 阻塞到下一个毫秒,获得新的时间戳
                timestamp = tilNextMillis(lastTimestamp);
            }
        }
        // 时间戳改变，毫秒内序列重置
        else {
            sequence = 0L;
        }

        // 将当前生成的时间戳记录为【上次时间戳】。【下次】生成时间戳时要用到。
        lastTimestamp = timestamp;

        // 移位并通过或运算拼到一起组成 64 位的 ID
        return ((timestamp - twepoch) << timestampLeftShift) // 时间戳部分
                | (dataCenterId << dataCenterIdShift) // 数据中心部分
                | (workerId << workerIdShift) // 机器标识部分
                | sequence; // 序列号部分
    }

    /**
     * 阻塞到下一个毫秒，直到获得新的时间戳
     *
     * @param lastTimestamp 上次生成ID的时间截
     * @return 当前时间戳
     */
    protected long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    /**
     * 返回以毫秒为单位的当前时间
     *
     * @return 当前时间(毫秒)
     */
    protected long timeGen() {
        return System.currentTimeMillis();
    }

    //==============================Test=============================================

    /**
     * 测试
     */
    public static void main(String[] args) {
        System.out.println(System.currentTimeMillis());
        SnowflakeIdWorker idWorker = new SnowflakeIdWorker(1, 1);
        long startTime = System.nanoTime();
        for (int i = 0; i < 50000; i++) {
            long id = idWorker.nextId();
            System.out.println(id);
        }
        System.out.println((System.nanoTime() - startTime) / 1000000 + "ms");
    }
}
